//    CANAPE Network Testing Tool
//    Copyright (C) 2014 Context Information Security
//
//    This program is free software: you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation, either version 3 of the License, or
//    (at your option) any later version.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with this program.  If not, see <http://www.gnu.org/licenses/>.

using System.Drawing;
using System.Windows.Forms;
using CANAPE.Documents;

namespace CANAPE.Extension
{
    /// <summary>
    /// Interface to create a document
    /// </summary>
    public interface IDocumentFactory
    {
        /// <summary>
        /// Create the document, passing a window handle for use with dialogue boxes
        /// </summary>
        /// <param name="window">The window handle</param>
        /// <returns>The created document</returns>
        IDocumentObject CreateDocument(IWin32Window window);

        /// <summary>
        /// Get icon for document
        /// </summary>
        /// <param name="document">The document</param>
        /// <returns>An icon, null if no icon available</returns>
        Icon GetIconForDocument(IDocumentObject document); 
    }
}
